home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 2000 April: Mac OS SDK / Dev.CD Apr 00 SDK1.toast / Development Kits / Mac OS / UPDATE- Int&Libs 3.2 / CIncludes / ATSUnicode.h < prev    next >
Encoding:
C/C++ Source or Header  |  1999-05-25  |  39.4 KB  |  1,121 lines  |  [TEXT/MPS ]
  1. /*
  2.      File:        ATSUnicode.h
  3.  
  4.      Contains:    Public interfaces for Apple Type Services for Unicode Imaging
  5.  
  6.      Version:    Technology:    Allegro
  7.                  Release:    Veronica Seed, Use with 3.2 Universal Interfaces
  8.  
  9.      Copyright:    © 1997-1999 by Apple Computer, Inc., all rights reserved.
  10.  
  11.      Bugs?:        For bug reports, consult the following page on
  12.                  the World Wide Web:
  13.  
  14.                      http://developer.apple.com/bugreporter/
  15.  
  16. */
  17. #ifndef __ATSUNICODE__
  18. #define __ATSUNICODE__
  19.  
  20. #ifndef __ATSLAYOUTTYPES__
  21. #include <ATSLayoutTypes.h>
  22. #endif
  23. #ifndef __SFNTLAYOUTTYPES__
  24. #include <SFNTLayoutTypes.h>
  25. #endif
  26.  
  27. #ifndef __MACTYPES__
  28. #include <MacTypes.h>
  29. #endif
  30. #ifndef __MACMEMORY__
  31. #include <MacMemory.h>
  32. #endif
  33. #ifndef __QUICKDRAW__
  34. #include <Quickdraw.h>
  35. #endif
  36. #ifndef __TEXTCOMMON__
  37. #include <TextCommon.h>
  38. #endif
  39.  
  40.  
  41.  
  42. #if PRAGMA_ONCE
  43. #pragma once
  44. #endif
  45.  
  46. #ifdef __cplusplus
  47. extern "C" {
  48. #endif
  49.  
  50. #if PRAGMA_IMPORT
  51. #pragma import on
  52. #endif
  53.  
  54. #if PRAGMA_STRUCT_ALIGN
  55.     #pragma options align=mac68k
  56. #elif PRAGMA_STRUCT_PACKPUSH
  57.     #pragma pack(push, 2)
  58. #elif PRAGMA_STRUCT_PACK
  59.     #pragma pack(2)
  60. #endif
  61.  
  62. /************/
  63. /*    Types    */
  64. /************/
  65. /*
  66.       UniCharArrayHandle is a handle type to correspond to 
  67.       UniCharArrayPtr, defined in Unicode.h.  It refers 
  68.       to a handle, interpreted as a pointer to an array 
  69.       of UniChar's (UInt16's).
  70. */
  71.  
  72. typedef UniCharArrayPtr *                UniCharArrayHandle;
  73. /*
  74.       UniCharArrayOffset is used to indicate an offset 
  75.       into an array of UniChar's (UInt16's).  
  76. */
  77. typedef UInt32                             UniCharArrayOffset;
  78. /*
  79.       ATSUTextMeasurement is specific to ATSUI in that measurement
  80.       quantities are in fractional Fixed format instead of shorts
  81.       used in QuickDraw Text.  This provides exact outline metrics and
  82.       line specifications such as line width, ascent, descent, and so on.  
  83. */
  84. typedef Fixed                             ATSUTextMeasurement;
  85. /*
  86.       ATSUFontID indicates a particular font family and face.  
  87.       ATSUFontID's are not guaranteed to remain constant across 
  88.       reboots.  Clients should use the font's unique name to 
  89.       get a font token to store in documents which is 
  90.       guaranteed to remain constant across reboots. 
  91. */
  92. typedef UInt32                             ATSUFontID;
  93. /*
  94.       ATSUFontFeatureType and ATSUFontFeatureSelector are used 
  95.       to identify font features.  
  96. */
  97. typedef UInt16                             ATSUFontFeatureType;
  98. typedef UInt16                             ATSUFontFeatureSelector;
  99. /*
  100.       ATSUFontVariationAxis and ATSUFontVariationValue are used 
  101.       in connection with font variations.  
  102. */
  103. typedef FourCharCode                     ATSUFontVariationAxis;
  104. typedef Fixed                             ATSUFontVariationValue;
  105. /*
  106.       ATSUTextLayout is used to store the attribute information 
  107.       associated with a contiguous block of UniChar's (UInt16's) 
  108.       in memory.  It's typed to be an opaque structure.  
  109. */
  110. typedef struct OpaqueATSUTextLayout*     ATSUTextLayout;
  111. /*
  112.       ATSUStyle is used to store a set of individual attributes, 
  113.       font features, and font variations.  It's typed to be 
  114.       an opaque structure.  
  115. */
  116. typedef struct OpaqueATSUStyle*         ATSUStyle;
  117. /*
  118.       ATSUAttributeTag is used to indicate the particular type 
  119.       of attribute under consideration:  font, size, color, 
  120.       and so on.  
  121.       Each style run may have at most one attribute with a 
  122.       given ATSUAttributeTag (i.e., a style run can't have 
  123.       more than one font or size) but may have none.  
  124. */
  125. typedef UInt32                             ATSUAttributeTag;
  126. /*
  127.       ATSUAttributeValuePtr is used to provide generic access 
  128.       to storage of attribute values, which vary in size.
  129. */
  130. typedef void *                            ATSUAttributeValuePtr;
  131. /*
  132.       ATSUAttributeInfo is used to provide a tag/size pairing.  
  133.       This makes it possible to provide the client information   
  134.       about all the attributes for a given range of text.  This   
  135.       structure is only used to return to the client information   
  136.       about a complete set of attributes.  An array of   
  137.       ATSUAttributeInfos is passed as a parameter so that the   
  138.       client can find out what attributes are set and what their   
  139.       individual sizes are; with that information, they can then   
  140.       query about the values of the attributes they're interested   
  141.       in.  Because arrays of ATSUAttributeInfos are used as parameters   
  142.       to functions, they have to be of a fixed size, hence the   
  143.       value is not included in the structure.  
  144. */
  145.  
  146. struct ATSUAttributeInfo {
  147.     ATSUAttributeTag                 fTag;
  148.     ByteCount                         fValueSize;
  149. };
  150. typedef struct ATSUAttributeInfo        ATSUAttributeInfo;
  151. /*
  152.       ATSUCaret contains the complete information needed to render a
  153.       caret.  fX and fY is the position of one of the caret's ends
  154.       relative to the origin position of the line the caret belongs.
  155.       fDeltaX and fDeltaY is the position of the caret's other end.
  156.       Hence, to draw a caret, simply call MoveTo(fX, fY) followed by
  157.       LineTo(fDeltaX, fDeltaY) or equivalent.  The ATSUCaret will
  158.       contain the positions needed to draw carets on angled lines
  159.       and reflect angled carets and leading/trailing split caret
  160.       appearances.
  161. */
  162.  
  163. struct ATSUCaret {
  164.     Fixed                             fX;
  165.     Fixed                             fY;
  166.     Fixed                             fDeltaX;
  167.     Fixed                             fDeltaY;
  168. };
  169. typedef struct ATSUCaret                ATSUCaret;
  170. /*
  171.       ATSUCursorMovementType currently can take three values 
  172.       (kATSUByCharacter, kATSUByCluster, and kATSUByWord) 
  173.       and is used to indicate how much to move the cursor.  
  174. */
  175.  
  176. typedef UInt16                             ATSUCursorMovementType;
  177. /*
  178.       ATSUVerticalCharacterType currently can take two values 
  179.       (kATSUStronglyVertical, and kATSUStronglyHorizontal) and 
  180.       is used to indicate whether text is to be laid out as 
  181.       vertical glyphs or horizontal glyphs.  
  182. */
  183. typedef UInt16                             ATSUVerticalCharacterType;
  184. /*
  185.       ATSUStyleComparison is an enumeration with four values 
  186.       (kATUStyleUnequal, ATSUStyleContains, kATSUStyleEquals, 
  187.       and kATSUStyleContainedBy), and is used by ATSUCompareStyles() 
  188.       to indicate if the first style parameter contains as a 
  189.       proper subset, is equal to, or is contained by the second 
  190.       style parameter.
  191. */
  192. typedef UInt16                             ATSUStyleComparison;
  193. /*
  194.       ATSUFontFallbackMethod type defines the type of heap or memory callback
  195.       method ATSUI is to follow iin all its permanent memory allocations for
  196.       it clients.
  197. */
  198. typedef UInt16                             ATSUFontFallbackMethod;
  199. /*
  200.       ATSUMemoryCallbacks is a union struct that allows the ATSUI 
  201.       client to specify a specific heap for ATSUI use or allocation
  202.       callbacks of which ATSUI is to use each time ATSUI performs a
  203.       memory operation (alloc, grow, free).
  204. */
  205. typedef CALLBACK_API_C( void *, ATSUCustomAllocFunc )(void *refCon, ByteCount howMuch);
  206. typedef CALLBACK_API_C( void , ATSUCustomFreeFunc )(void *refCon, void *doomedBlock);
  207. typedef CALLBACK_API_C( void *, ATSUCustomGrowFunc )(void *refCon, void *oldBlock, ByteCount oldSize, ByteCount newSize);
  208.  
  209. union ATSUMemoryCallbacks {
  210.     struct {
  211.         ATSUCustomAllocFunc             Alloc;
  212.         ATSUCustomFreeFunc                 Free;
  213.         ATSUCustomGrowFunc                 Grow;
  214.         void *                            memoryRefCon;
  215.     }                                 callbacks;
  216.  
  217.     THz                             heapToUse;
  218. };
  219. typedef union ATSUMemoryCallbacks        ATSUMemoryCallbacks;
  220. /*
  221.       ATSUHeapSpec provides allows the ATSUI client a means of
  222.       specifying the heap ATSUI should allocate it's dynamic memory
  223.       from or that ATSUI should use the memory callback provided by
  224.       the client.
  225. */
  226.  
  227. typedef UInt16                             ATSUHeapSpec;
  228. /*
  229.       ATSUMemorySetting is used to store the results from a ATSUSetMemoryAlloc
  230.       or a ATSUGetCurrentMemorySetting call.  It can also be used to change the
  231.       current ATSUMemorySetting by passing it into the ATSUSetCurrentMemorySetting
  232.       call.
  233. */
  234. typedef struct OpaqueATSUMemorySetting*  ATSUMemorySetting;
  235. /****************************************************/
  236. /*    Gestalt selectors                                */
  237. /*        Move into Gestalt.i when they're stable!!!!    */
  238. /****************************************************/
  239. enum {
  240.     gestaltATSUVersion            = FOUR_CHAR_CODE('uisv'),
  241.     gestaltATSUFeatures            = FOUR_CHAR_CODE('uisf')
  242. };
  243.  
  244. enum {
  245.     gestaltOriginalATSUVersion    = (1 << 16),
  246.     gestaltATSUUpdate1            = (2 << 16)
  247. };
  248.  
  249. enum {
  250.     gestaltATSUTrackingFeature    = 0x00000001,
  251.     gestaltATSUMemoryFeature    = 0x00000001,
  252.     gestaltATSUFallbacksFeature    = 0x00000001,
  253.     gestaltATSUGlyphBoundsFeature = 0x00000001,
  254.     gestaltATSULineControlFeature = 0x00000001,
  255.     gestaltATSULayoutCreateAndCopyFeature = 0x00000001,
  256.     gestaltATSULayoutCacheClearFeature = 0x00000001
  257. };
  258.  
  259. /****************/
  260. /*    Error codes    */
  261. /****************/
  262. enum {
  263.     kATSUInvalidTextLayoutErr    = -8790,                        /*    An attempt was made to use a ATSUTextLayout */
  264.                                                                 /*    which hadn't been initialized or is otherwise */
  265.                                                                 /*    in an invalid state. */
  266.     kATSUInvalidStyleErr        = -8791,                        /*    An attempt was made to use a ATSUStyle which  */
  267.                                                                 /*    hadn't been properly allocated or is otherwise  */
  268.                                                                 /*    in an invalid state.  */
  269.     kATSUInvalidTextRangeErr    = -8792,                        /*    An attempt was made to extract information   */
  270.                                                                 /*    from or perform an operation on a ATSUTextLayout */
  271.                                                                 /*    for a range of text not covered by the ATSUTextLayout.  */
  272.     kATSUFontsMatched            = -8793,                        /*    This is not an error code but is returned by    */
  273.                                                                 /*    ATSUMatchFontsToText() when changes need to    */
  274.                                                                 /*    be made to the fonts associated with the text.  */
  275.     kATSUFontsNotMatched        = -8794,                        /*    This value is returned by ATSUMatchFontsToText()    */
  276.                                                                 /*    when the text contains Unicode characters which    */
  277.                                                                 /*    cannot be represented by any installed font.  */
  278.     kATSUNoCorrespondingFontErr    = -8795,                        /*    This value is retrned by font ID conversion */
  279.                                                                 /*    routines ATSUFONDtoFontID() and ATSUFontIDtoFOND() */
  280.                                                                 /*    to indicate that the input font ID is valid but */
  281.                                                                 /*    there is no conversion possible.  For example, */
  282.                                                                 /*    data-fork fonts can only be used with ATSUI not */
  283.                                                                 /*    the FontManager, and so converting an ATSUIFontID */
  284.                                                                 /*    for such a font will fail.   */
  285.     kATSUInvalidFontErr            = -8796,                        /*    Used when an attempt was made to use an invalid font ID.*/
  286.     kATSUInvalidAttributeValueErr = -8797,                        /*    Used when an attempt was made to use an attribute with */
  287.                                                                 /*    a bad or undefined value.  */
  288.     kATSUInvalidAttributeSizeErr = -8798,                        /*    Used when an attempt was made to use an attribute with a */
  289.                                                                 /*    bad size.  */
  290.     kATSUInvalidAttributeTagErr    = -8799,                        /*    Used when an attempt was made to use a tag value that*/
  291.                                                                 /*    was not appropriate for the function call it was used.  */
  292.     kATSUInvalidCacheErr        = -8800,                        /*    Used when an attempt was made to read in style data */
  293.                                                                 /*    from an invalid cache.  Either the format of the */
  294.                                                                 /*    cached data doesn't match that used by Apple Type */
  295.                                                                 /*    Services for Unicode™ Imaging, or the cached data */
  296.                                                                 /*    is corrupt.  */
  297.     kATSUNotSetErr                = -8801,                        /*    Used when the client attempts to retrieve an attribute, */
  298.                                                                 /*    font feature, or font variation from a style when it */
  299.                                                                 /*    hadn't been set.  In such a case, the default value will*/
  300.                                                                 /*    be returned for the attribute's value.*/
  301.     kATSUNoStyleRunsAssignedErr    = -8802,                        /*    Used when an attempt was made to measure, highlight or draw*/
  302.                                                                 /*    a ATSUTextLayout object that has no styleRuns associated with it.*/
  303.     kATSUQuickDrawTextErr        = -8803,                        /*    Used when QuickDraw Text encounters an error rendering or measuring*/
  304.                                                                 /*    a line of ATSUI text.*/
  305.     kATSULowLevelErr            = -8804,                        /*    Used when an error was encountered within the low level ATS */
  306.                                                                 /*    mechanism performing an operation requested by ATSUI.*/
  307.     kATSUNoFontCmapAvailableErr    = -8805,                        /*    Used when no CMAP table can be accessed or synthesized for the */
  308.                                                                 /*    font passed into a SetAttributes Font call.*/
  309.     kATSUNoFontScalerAvailableErr = -8806,                        /*    Used when no font scaler is available for the font passed*/
  310.                                                                 /*    into a SetAttributes Font call.*/
  311.     kATSUCoordinateOverflowErr    = -8807,                        /*    Used to indicate the coordinates provided to an ATSUI routine caused*/
  312.                                                                 /*    a coordinate overflow (i.e. > 32K).*/
  313.     kATSULastErr                = -8808                            /*    The last ATSUI error code.*/
  314. };
  315.  
  316. /*******************************************************************************/
  317. /*    ATSUI Attribute tags:  Apple reserves values 0 to 65,535 (0 to 0x0000FFFF) */
  318. /*    ATSUI clients may create their own tags with any other value               */
  319. /*******************************************************************************/
  320. /*    Line Control Attribute Tags */
  321. enum {
  322.     kATSULineWidthTag            = 1L,                            /*    Type:            ATSUTextMeasurement*/
  323.                                                                 /*    Default value:    0*/
  324.     kATSULineRotationTag        = 2L,                            /*    Type:            Fixed (fixed value in degrees in right-handed coordinate system)*/
  325.                                                                 /*    Default value:    0*/
  326.     kATSULineDirectionTag        = 3L,                            /*    Type:            Boolean; values 0 or 1 (see below for value identities)*/
  327.                                                                 /*    Default value:    GetSysDirection() ? kATSURightToLeftBaseDirection : kATSULeftToRightBaseDirection*/
  328.     kATSULineJustificationFactorTag = 4L,                        /*    Type:            Fract between 0 and 1*/
  329.                                                                 /*    Default value:    kATSUNoJustification*/
  330.     kATSULineFlushFactorTag        = 5L,                            /*    Type:            Fract between 0 and 1 */
  331.                                                                 /*    Default value:    kATSUStartAlignment*/
  332.     kATSULineBaselineValuesTag    = 6L,                            /*    Type:            BslnBaselineRecord*/
  333.                                                                 /*    Default value:    All zeros.  Calculated from other style attributes (e.g., font and point size)*/
  334.     kATSULineLayoutOptionsTag    = 7L,                            /*    Type:            UInt32*/
  335.                                                                 /*    Default value:    kATSLineNoLayoutOptions - other options listed in ATSLayoutTypes.h*/
  336.     kATSULineAscentTag            = 8L,                            /*    Type:            ATSUTextMeasurement*/
  337.                                                                 /*    Default value:    kATSUseLineHeight*/
  338.                                                                 /*    Type:            ATSUTextMeasurement*/
  339.     kATSULineDescentTag            = 9L                            /*    Default value:    kATSUseLineHeight*/
  340. };
  341.  
  342. /*    Run Style Attribute Tags */
  343. enum {
  344.                                                                 /* QuickDraw compatibility tags */
  345.     kATSUQDBoldfaceTag            = 256L,                            /*    Type:            Boolean    */
  346.                                                                 /*    Default value:    false*/
  347.     kATSUQDItalicTag            = 257L,                            /*    Type:            Boolean        */
  348.                                                                 /*    Default value:    false*/
  349.     kATSUQDUnderlineTag            = 258L,                            /*    Type:            Boolean    */
  350.                                                                 /*    Default value:    false*/
  351.     kATSUQDCondensedTag            = 259L,                            /*    Type:            Boolean    */
  352.                                                                 /*    Default value:    false*/
  353.     kATSUQDExtendedTag            = 260L,                            /*    Type:            Boolean    */
  354.                                                                 /*    Default value:    false*/
  355.                                                                 /* Common run tags */
  356.     kATSUFontTag                = 261L,                            /*    Type:            ATSUFontID    */
  357.                                                                 /*    Default value:    GetScriptVariable( smSystemScript, smScriptAppFond )*/
  358.     kATSUSizeTag                = 262L,                            /*    Type:            Fixed    */
  359.                                                                 /*    Default value:    GetScriptVariable( smSystemScript, smScriptAppFondSize )    */
  360.     kATSUColorTag                = 263L,                            /*    Type:            RGBColor    */
  361.                                                                 /*    Default value:    (0, 0, 0)*/
  362.                                                                 /*    Less common run tags */
  363.     kATSULanguageTag            = 264L,                            /*    Type:            RegionCode    */
  364.                                                                 /*    Default value:    GetScriptVariable( smSystemScript, smScriptLang )*/
  365.     kATSUVerticalCharacterTag    = 265L,                            /*    Type:            ATSUVerticalCharacterType    */
  366.                                                                 /*    Default value:    kATSUStronglyHorizontal*/
  367.     kATSUImposeWidthTag            = 266L,                            /*    Type:            ATSUTextMeasurement*/
  368.                                                                 /*    Default value:    all glyphs use their own font defined advance widths*/
  369.     kATSUBeforeWithStreamShiftTag = 267L,                        /*    Type:            Fixed*/
  370.                                                                 /*    Default value:    0*/
  371.     kATSUAfterWithStreamShiftTag = 268L,                        /*    Type:            Fixed*/
  372.                                                                 /*    Default value:    0*/
  373.     kATSUCrossStreamShiftTag    = 269L,                            /*    Type:            Fixed*/
  374.                                                                 /*    Default value:    0*/
  375.     kATSUTrackingTag            = 270L,                            /*    Type:            Fixed*/
  376.                                                                 /*    Default value:    kATSNoTracking*/
  377.     kATSUHangingInhibitFactorTag = 271L,                        /*    Type:            Fract between 0 and 1*/
  378.                                                                 /*    Default value:    0*/
  379.     kATSUKerningInhibitFactorTag = 272L,                        /*    Type:            Fract between 0 and 1*/
  380.                                                                 /*    Default value:    0*/
  381.     kATSUDecompositionFactorTag    = 273L,                            /*    Type:            Fixed (-1.0 -> 1.0)*/
  382.                                                                 /*    Default value:    0*/
  383.     kATSUBaselineClassTag        = 274L,                            /*    Type:            BslnBaselineClass  (see SFNTLayoutTypes.h)*/
  384.                                                                 /*    Default value:    kBSLNRomanBaseline - set to kBSLNNoBaselineOverride to use intrinsic baselines*/
  385.     kATSUPriorityJustOverrideTag = 275L,                        /*    Type:            ATSJustPriorityWidthDeltaOverrides (see ATSLayoutTypes.h)*/
  386.                                                                 /*    Default value:    all zeros*/
  387.     kATSUNoLigatureSplitTag        = 276L,                            /*    Type:            Boolean*/
  388.                                                                 /*    Default value:    false - ligatures and compound characters have divisable components.*/
  389.     kATSUNoCaretAngleTag        = 277L,                            /*    Type:            Boolean*/
  390.                                                                 /*    Default value:    false - use the character's angularity to determine its boundaries*/
  391.     kATSUSuppressCrossKerningTag = 278L,                        /*    Type:            Boolean*/
  392.                                                                 /*    Default value:    false - do not suppress automatic cross kerning (defined by font)*/
  393.     kATSUNoOpticalAlignmentTag    = 279L,                            /*    Type:            Boolean*/
  394.                                                                 /*    Default value:    false - do not suppress character's automatic optical positional alignment*/
  395.     kATSUForceHangingTag        = 280L,                            /*    Type:            Boolean*/
  396.                                                                 /*    Default value:    false - do not force the character's to hang beyond the line boundaries*/
  397.     kATSUNoSpecialJustificationTag = 281L,                        /*    Type:            Boolean*/
  398.                                                                 /*    Default value:    false - perform post-compensation justification if needed*/
  399.     kATSUMaxStyleTag            = 282L,                            /*    This is just for convenience - the upper limit of the ATSUStyle attribute tags */
  400.     kATSUMaxATSUITagValue        = 65535L                        /*    This is the maximum Apple ATSUI reserved tag value.  Client defined tags must be larger.*/
  401. };
  402.  
  403. /********************************/
  404. /*    Enumerations and constants    */
  405. /********************************/
  406. /* Cursor movement */
  407. enum {
  408.     kATSUByCharacter            = 0,
  409.     kATSUByCluster                = 1,
  410.     kATSUByWord                    = 2
  411. };
  412.  
  413. /* Vertical text types */
  414. enum {
  415.     kATSUStronglyHorizontal        = 0,
  416.     kATSUStronglyVertical        = 1
  417. };
  418.  
  419. /* Line direction types (used for kATSULineDirectionTag values) */
  420. enum {
  421.     kATSULeftToRightBaseDirection = 0,                            /*    Impose left-to-right or top-to-bottom dominant direction */
  422.     kATSURightToLeftBaseDirection = 1                            /*    Impose right-to-left or bottom-to-top dominant direction */
  423. };
  424.  
  425. /* Style comparison types */
  426. enum {
  427.     kATSUStyleUnequal            = 0,
  428.     kATSUStyleContains            = 1,
  429.     kATSUStyleEquals            = 2,
  430.     kATSUStyleContainedBy        = 3
  431. };
  432.  
  433. /* Font Fallback methods */
  434. enum {
  435.     kATSUDefaultFontFallbacks    = 0,
  436.     kATSULastResortOnlyFallback    = 1,
  437.     kATSUSequentialFallbacksPreferred = 2,
  438.     kATSUSequentialFallbacksExclusive = 3
  439. };
  440.  
  441. /* ATSUI heap or memory allocation specifiers (of type ATSUHeapSpec) */
  442. enum {
  443.     kATSUUseCurrentHeap            = 0,
  444.     kATSUUseAppHeap                = 1,
  445.     kATSUUseSpecificHeap        = 2,
  446.     kATSUUseCallbacks            = 3
  447. };
  448.  
  449. /* LineFlushFactor convenience defined values */
  450. #define kATSUStartAlignment            ((Fract) 0x00000000L)
  451. #define kATSUEndAlignment            ((Fract) 0x40000000L)
  452. #define kATSUCenterAlignment        ((Fract) 0x20000000L)
  453. /* LineJustificationFactor convenience defined values */
  454. #define kATSUNoJustification        ((Fract) 0x00000000L)
  455. #define kATSUFullJustification        ((Fract) 0x40000000L)
  456. /* Other constants    */
  457. enum {
  458.     kATSUInvalidFontID            = 0
  459. };
  460.  
  461.  
  462. enum {
  463.     kATSUUseLineControlWidth    = 0x7FFFFFFF
  464. };
  465.  
  466.  
  467. enum {
  468.     kATSUNoSelector                = 0x0000FFFF
  469. };
  470.  
  471.  
  472. enum {
  473.     kATSUUseGrafPortPenLoc        = (long)0xFFFFFFFF,
  474.     kATSUClearAll                = (long)0xFFFFFFFF
  475. };
  476.  
  477.  
  478. enum {
  479.     kATSUFromTextBeginning        = (long)0xFFFFFFFF,
  480.     kATSUToTextEnd                = (long)0xFFFFFFFF
  481. };
  482.  
  483.  
  484. /****************/
  485. /*    Functions    */
  486. /****************/
  487.  
  488. /*    Clipboard support, flattened style version 0 (is is advised to not use these routines and perform your own flattening)    */
  489. EXTERN_API_C( OSStatus )
  490. ATSUCopyToHandle                (ATSUStyle                 iStyle,
  491.                                  Handle                 oStyleHandle);
  492.  
  493. EXTERN_API_C( OSStatus )
  494. ATSUPasteFromHandle                (ATSUStyle                 iStyle,
  495.                                  Handle                 iStyleHandle);
  496.  
  497. /*    Memory allocation specification functions    */
  498. EXTERN_API_C( OSStatus )
  499. ATSUCreateMemorySetting            (ATSUHeapSpec             iHeapSpec,
  500.                                  ATSUMemoryCallbacks *    iMemoryCallbacks,
  501.                                  ATSUMemorySetting *    oMemorySetting);
  502.  
  503. EXTERN_API_C( OSStatus )
  504. ATSUSetCurrentMemorySetting        (ATSUMemorySetting         iMemorySetting);
  505.  
  506. EXTERN_API_C( ATSUMemorySetting )
  507. ATSUGetCurrentMemorySetting        (void);
  508.  
  509. EXTERN_API_C( OSStatus )
  510. ATSUDisposeMemorySetting        (ATSUMemorySetting         iMemorySetting);
  511.  
  512. /*    Basic style functions    */
  513. EXTERN_API_C( OSStatus )
  514. ATSUCreateStyle                    (ATSUStyle *            oStyle);
  515.  
  516. EXTERN_API_C( OSStatus )
  517. ATSUCreateAndCopyStyle            (ATSUStyle                 iStyle,
  518.                                  ATSUStyle *            oStyle);
  519.  
  520. EXTERN_API_C( OSStatus )
  521. ATSUDisposeStyle                (ATSUStyle                 iStyle);
  522.  
  523. EXTERN_API_C( OSStatus )
  524. ATSUSetStyleRefCon                (ATSUStyle                 iStyle,
  525.                                  UInt32                 iRefCon);
  526.  
  527. EXTERN_API_C( OSStatus )
  528. ATSUGetStyleRefCon                (ATSUStyle                 iStyle,
  529.                                  UInt32 *                oRefCon);
  530.  
  531. /*    Style comparison         */
  532. EXTERN_API_C( OSStatus )
  533. ATSUCompareStyles                (ATSUStyle                 iFirstStyle,
  534.                                  ATSUStyle                 iSecondStyle,
  535.                                  ATSUStyleComparison *    oComparison);
  536.  
  537. /*    Attribute manipulations    */
  538. EXTERN_API_C( OSStatus )
  539. ATSUCopyAttributes                (ATSUStyle                 iSourceStyle,
  540.                                  ATSUStyle                 iDestinationStyle);
  541.  
  542. EXTERN_API_C( OSStatus )
  543. ATSUOverwriteAttributes            (ATSUStyle                 iSourceStyle,
  544.                                  ATSUStyle                 iDestinationStyle);
  545.  
  546. EXTERN_API_C( OSStatus )
  547. ATSUUnderwriteAttributes        (ATSUStyle                 iSourceStyle,
  548.                                  ATSUStyle                 iDestinationStyle);
  549.  
  550. /*    Empty styles    */
  551. EXTERN_API_C( OSStatus )
  552. ATSUClearStyle                    (ATSUStyle                 iStyle);
  553.  
  554. EXTERN_API_C( OSStatus )
  555. ATSUStyleIsEmpty                (ATSUStyle                 iStyle,
  556.                                  Boolean *                oIsClear);
  557.  
  558. /*    Get and set attributes */
  559. EXTERN_API_C( OSStatus )
  560. ATSUCalculateBaselineDeltas        (ATSUStyle                 iStyle,
  561.                                  BslnBaselineClass         iBaselineClass,
  562.                                  BslnBaselineRecord     oBaselineDeltas);
  563.  
  564. EXTERN_API_C( OSStatus )
  565. ATSUSetAttributes                (ATSUStyle                 iStyle,
  566.                                  ItemCount                 iAttributeCount,
  567.                                  ATSUAttributeTag         iTag[],
  568.                                  ByteCount                 iValueSize[],
  569.                                  ATSUAttributeValuePtr     iValue[]);
  570.  
  571. EXTERN_API_C( OSStatus )
  572. ATSUGetAttribute                (ATSUStyle                 iStyle,
  573.                                  ATSUAttributeTag         iTag,
  574.                                  ByteCount                 iExpectedValueSize,
  575.                                  ATSUAttributeValuePtr     oValue,
  576.                                  ByteCount *            oActualValueSize);
  577.  
  578. EXTERN_API_C( OSStatus )
  579. ATSUGetAllAttributes            (ATSUStyle                 iStyle,
  580.                                  ATSUAttributeInfo         oAttributeInfoArray[],
  581.                                  ItemCount                 iTagValuePairArraySize,
  582.                                  ItemCount *            oTagValuePairCount);
  583.  
  584. EXTERN_API_C( OSStatus )
  585. ATSUClearAttributes                (ATSUStyle                 iStyle,
  586.                                  ItemCount                 iTagCount,
  587.                                  ATSUAttributeTag         iTag[]);
  588.  
  589. /*    Font features    */
  590. EXTERN_API_C( OSStatus )
  591. ATSUSetFontFeatures                (ATSUStyle                 iStyle,
  592.                                  ItemCount                 iFeatureCount,
  593.                                  ATSUFontFeatureType     iType[],
  594.                                  ATSUFontFeatureSelector  iSelector[]);
  595.  
  596. EXTERN_API_C( OSStatus )
  597. ATSUGetFontFeature                (ATSUStyle                 iStyle,
  598.                                  ItemCount                 iFeatureIndex,
  599.                                  ATSUFontFeatureType *    oFeatureType,
  600.                                  ATSUFontFeatureSelector * oFeatureSelector);
  601.  
  602. EXTERN_API_C( OSStatus )
  603. ATSUGetAllFontFeatures            (ATSUStyle                 iStyle,
  604.                                  ItemCount                 iMaximumFeatureCount,
  605.                                  ATSUFontFeatureType     oFeatureType[],
  606.                                  ATSUFontFeatureSelector  oFeatureSelector[],
  607.                                  ItemCount *            oActualFeatureCount);
  608.  
  609. EXTERN_API_C( OSStatus )
  610. ATSUClearFontFeatures            (ATSUStyle                 iStyle,
  611.                                  ItemCount                 iFeatureCount,
  612.                                  ATSUFontFeatureType     iType[],
  613.                                  ATSUFontFeatureSelector  iSelector[]);
  614.  
  615. /*    Font variations    */
  616. EXTERN_API_C( OSStatus )
  617. ATSUSetVariations                (ATSUStyle                 iStyle,
  618.                                  ItemCount                 iVariationCount,
  619.                                  ATSUFontVariationAxis     iAxes[],
  620.                                  ATSUFontVariationValue  iValue[]);
  621.  
  622. EXTERN_API_C( OSStatus )
  623. ATSUGetFontVariationValue        (ATSUStyle                 iStyle,
  624.                                  ATSUFontVariationAxis     iFontVariationAxis,
  625.                                  ATSUFontVariationValue * oFontVariationValue);
  626.  
  627. EXTERN_API_C( OSStatus )
  628. ATSUGetAllFontVariations        (ATSUStyle                 iStyle,
  629.                                  ItemCount                 iVariationCount,
  630.                                  ATSUFontVariationAxis     oVariationAxes[],
  631.                                  ATSUFontVariationValue  oFontVariationValues[],
  632.                                  ItemCount *            oActualVariationCount);
  633.  
  634. EXTERN_API_C( OSStatus )
  635. ATSUClearFontVariations            (ATSUStyle                 iStyle,
  636.                                  ItemCount                 iAxisCount,
  637.                                  ATSUFontVariationAxis     iAxis[]);
  638.  
  639. /*    Basic text-layout functions    */
  640. EXTERN_API_C( OSStatus )
  641. ATSUCreateTextLayout            (ATSUTextLayout *        oTextLayout);
  642.  
  643. EXTERN_API_C( OSStatus )
  644. ATSUCreateAndCopyTextLayout        (ATSUTextLayout         iTextLayout,
  645.                                  ATSUTextLayout *        oTextLayout);
  646.  
  647. EXTERN_API_C( OSStatus )
  648. ATSUCreateTextLayoutWithTextPtr    (ConstUniCharArrayPtr     iText,
  649.                                  UniCharArrayOffset     iTextOffset,
  650.                                  UniCharCount             iTextLength,
  651.                                  UniCharCount             iTextTotalLength,
  652.                                  ItemCount                 iNumberOfRuns,
  653.                                  UniCharCount             iRunLengths[],
  654.                                  ATSUStyle                 iStyles[],
  655.                                  ATSUTextLayout *        oTextLayout);
  656.  
  657. EXTERN_API_C( OSStatus )
  658. ATSUCreateTextLayoutWithTextHandle (UniCharArrayHandle     iText,
  659.                                  UniCharArrayOffset     iTextOffset,
  660.                                  UniCharCount             iTextLength,
  661.                                  UniCharCount             iTextTotalLength,
  662.                                  ItemCount                 iNumberOfRuns,
  663.                                  UniCharCount             iRunLengths[],
  664.                                  ATSUStyle                 iStyles[],
  665.                                  ATSUTextLayout *        oTextLayout);
  666.  
  667. EXTERN_API_C( OSStatus )
  668. ATSUClearLayoutCache            (ATSUTextLayout         iTextLayout,
  669.                                  UniCharArrayOffset     iLineStart);
  670.  
  671. EXTERN_API_C( OSStatus )
  672. ATSUDisposeTextLayout            (ATSUTextLayout         iTextLayout);
  673.  
  674. EXTERN_API_C( OSStatus )
  675. ATSUSetTextLayoutRefCon            (ATSUTextLayout         iTextLayout,
  676.                                  UInt32                 iRefCon);
  677.  
  678. EXTERN_API_C( OSStatus )
  679. ATSUGetTextLayoutRefCon            (ATSUTextLayout         iTextLayout,
  680.                                  UInt32 *                oRefCon);
  681.  
  682. /*    Glyph bounds retrieval    */
  683. EXTERN_API_C( OSStatus )
  684. ATSUGetGlyphBounds                (ATSUTextLayout         iTextLayout,
  685.                                  ATSUTextMeasurement     iTextBasePointX,
  686.                                  ATSUTextMeasurement     iTextBasePointY,
  687.                                  UniCharArrayOffset     iBoundsCharStart,
  688.                                  UniCharCount             iBoundsCharLength,
  689.                                  UInt16                 iTypeOfBounds,
  690.                                  ItemCount                 iMaxNumberOfBounds,
  691.                                  ATSTrapezoid             oGlyphBounds[],
  692.                                  ItemCount *            oActualNumberOfBounds);
  693.  
  694. /*    Idle processing    */
  695. EXTERN_API_C( OSStatus )
  696. ATSUIdle                        (ATSUTextLayout         iTextLayout);
  697.  
  698. /*    Text location    */
  699. EXTERN_API_C( OSStatus )
  700. ATSUSetTextPointerLocation        (ATSUTextLayout         iTextLayout,
  701.                                  ConstUniCharArrayPtr     iText,
  702.                                  UniCharArrayOffset     iTextOffset,
  703.                                  UniCharCount             iTextLength,
  704.                                  UniCharCount             iTextTotalLength);
  705.  
  706. EXTERN_API_C( OSStatus )
  707. ATSUSetTextHandleLocation        (ATSUTextLayout         iTextLayout,
  708.                                  UniCharArrayHandle     iText,
  709.                                  UniCharArrayOffset     iTextOffset,
  710.                                  UniCharCount             iTextLength,
  711.                                  UniCharCount             iTextTotalLength);
  712.  
  713. EXTERN_API_C( OSStatus )
  714. ATSUGetTextLocation                (ATSUTextLayout         iTextLayout,
  715.                                  void **                oText,
  716.                                  Boolean *                oTextIsStoredInHandle,
  717.                                  UniCharArrayOffset *    oOffset,
  718.                                  UniCharCount *            oTextLength,
  719.                                  UniCharCount *            oTextTotalLength);
  720.  
  721. /*    Text manipulation    */
  722. EXTERN_API_C( OSStatus )
  723. ATSUTextDeleted                    (ATSUTextLayout         iTextLayout,
  724.                                  UniCharArrayOffset     iDeletedRangeStart,
  725.                                  UniCharCount             iDeletedRangeLength);
  726.  
  727. EXTERN_API_C( OSStatus )
  728. ATSUTextInserted                (ATSUTextLayout         iTextLayout,
  729.                                  UniCharArrayOffset     iInsertionLocation,
  730.                                  UniCharCount             iInsertionLength);
  731.  
  732. EXTERN_API_C( OSStatus )
  733. ATSUTextMoved                    (ATSUTextLayout         iTextLayout,
  734.                                  ConstUniCharArrayPtr     iNewLocation);
  735.  
  736. /*    Layout controls    */
  737. EXTERN_API_C( OSStatus )
  738. ATSUCopyLayoutControls            (ATSUTextLayout         iSourceTextLayout,
  739.                                  ATSUTextLayout         iDestTextLayout);
  740.  
  741. EXTERN_API_C( OSStatus )
  742. ATSUSetLayoutControls            (ATSUTextLayout         iTextLayout,
  743.                                  ItemCount                 iAttributeCount,
  744.                                  ATSUAttributeTag         iTag[],
  745.                                  ByteCount                 iValueSize[],
  746.                                  ATSUAttributeValuePtr     iValue[]);
  747.  
  748. EXTERN_API_C( OSStatus )
  749. ATSUGetLayoutControl            (ATSUTextLayout         iTextLayout,
  750.                                  ATSUAttributeTag         iTag,
  751.                                  ByteCount                 iExpectedValueSize,
  752.                                  ATSUAttributeValuePtr     oValue,
  753.                                  ByteCount *            oActualValueSize);
  754.  
  755. EXTERN_API_C( OSStatus )
  756. ATSUGetAllLayoutControls        (ATSUTextLayout         iTextLayout,
  757.                                  ATSUAttributeInfo         oAttributeInfoArray[],
  758.                                  ItemCount                 iTagValuePairArraySize,
  759.                                  ItemCount *            oTagValuePairCount);
  760.  
  761. EXTERN_API_C( OSStatus )
  762. ATSUClearLayoutControls            (ATSUTextLayout         iTextLayout,
  763.                                  ItemCount                 iTagCount,
  764.                                  ATSUAttributeTag         iTag[]);
  765.  
  766. /*    Single line layout controls    */
  767. EXTERN_API_C( OSStatus )
  768. ATSUCopyLineControls            (ATSUTextLayout         iSourceTextLayout,
  769.                                  UniCharArrayOffset     iSourceLineStart,
  770.                                  ATSUTextLayout         iDestTextLayout,
  771.                                  UniCharArrayOffset     iDestLineStart);
  772.  
  773. EXTERN_API_C( OSStatus )
  774. ATSUSetLineControls                (ATSUTextLayout         iTextLayout,
  775.                                  UniCharArrayOffset     iLineStart,
  776.                                  ItemCount                 iAttributeCount,
  777.                                  ATSUAttributeTag         iTag[],
  778.                                  ByteCount                 iValueSize[],
  779.                                  ATSUAttributeValuePtr     iValue[]);
  780.  
  781. EXTERN_API_C( OSStatus )
  782. ATSUGetLineControl                (ATSUTextLayout         iTextLayout,
  783.                                  UniCharArrayOffset     iLineStart,
  784.                                  ATSUAttributeTag         iTag,
  785.                                  ByteCount                 iExpectedValueSize,
  786.                                  ATSUAttributeValuePtr     oValue,
  787.                                  ByteCount *            oActualValueSize);
  788.  
  789. EXTERN_API_C( OSStatus )
  790. ATSUGetAllLineControls            (ATSUTextLayout         iTextLayout,
  791.                                  UniCharArrayOffset     iLineStart,
  792.                                  ATSUAttributeInfo         oAttributeInfoArray[],
  793.                                  ItemCount                 iTagValuePairArraySize,
  794.                                  ItemCount *            oTagValuePairCount);
  795.  
  796. EXTERN_API_C( OSStatus )
  797. ATSUClearLineControls            (ATSUTextLayout         iTextLayout,
  798.                                  UniCharArrayOffset     iLineStart,
  799.                                  ItemCount                 iTagCount,
  800.                                  ATSUAttributeTag         iTag[]);
  801.  
  802. /*    Style run processing    */
  803. EXTERN_API_C( OSStatus )
  804. ATSUSetRunStyle                    (ATSUTextLayout         iTextLayout,
  805.                                  ATSUStyle                 iStyle,
  806.                                  UniCharArrayOffset     iRunStart,
  807.                                  UniCharCount             iRunLength);
  808.  
  809. EXTERN_API_C( OSStatus )
  810. ATSUGetRunStyle                    (ATSUTextLayout         iTextLayout,
  811.                                  UniCharArrayOffset     iOffset,
  812.                                  ATSUStyle *            oStyle,
  813.                                  UniCharArrayOffset *    oRunStart,
  814.                                  UniCharCount *            oRunLength);
  815.  
  816. EXTERN_API_C( OSStatus )
  817. ATSUGetContinuousAttributes        (ATSUTextLayout         iTextLayout,
  818.                                  UniCharArrayOffset     iOffset,
  819.                                  UniCharCount             iLength,
  820.                                  ATSUStyle                 oStyle);
  821.  
  822. /*    Drawing and measuring    */
  823. EXTERN_API_C( OSStatus )
  824. ATSUDrawText                    (ATSUTextLayout         iTextLayout,
  825.                                  UniCharArrayOffset     iLineOffset,
  826.                                  UniCharCount             iLineLength,
  827.                                  ATSUTextMeasurement     iLocationX,
  828.                                  ATSUTextMeasurement     iLocationY);
  829.  
  830. EXTERN_API_C( OSStatus )
  831. ATSUMeasureText                    (ATSUTextLayout         iTextLayout,
  832.                                  UniCharArrayOffset     iLineStart,
  833.                                  UniCharCount             iLineLength,
  834.                                  ATSUTextMeasurement *    oTextBefore,
  835.                                  ATSUTextMeasurement *    oTextAfter,
  836.                                  ATSUTextMeasurement *    oAscent,
  837.                                  ATSUTextMeasurement *    oDescent);
  838.  
  839. EXTERN_API_C( OSStatus )
  840. ATSUMeasureTextImage            (ATSUTextLayout         iTextLayout,
  841.                                  UniCharArrayOffset     iLineOffset,
  842.                                  UniCharCount             iLineLength,
  843.                                  ATSUTextMeasurement     iLocationX,
  844.                                  ATSUTextMeasurement     iLocationY,
  845.                                  Rect *                    oTextImageRect);
  846.  
  847. /*    Highlighting    */
  848. EXTERN_API_C( OSStatus )
  849. ATSUHighlightText                (ATSUTextLayout         iTextLayout,
  850.                                  ATSUTextMeasurement     iTextBasePointX,
  851.                                  ATSUTextMeasurement     iTextBasePointY,
  852.                                  UniCharArrayOffset     iHighlightStart,
  853.                                  UniCharCount             iHighlightLength);
  854.  
  855. EXTERN_API_C( OSStatus )
  856. ATSUUnhighlightText                (ATSUTextLayout         iTextLayout,
  857.                                  ATSUTextMeasurement     iTextBasePointX,
  858.                                  ATSUTextMeasurement     iTextBasePointY,
  859.                                  UniCharArrayOffset     iHighlightStart,
  860.                                  UniCharCount             iHighlightLength);
  861.  
  862. EXTERN_API_C( OSStatus )
  863. ATSUGetTextHighlight            (ATSUTextLayout         iTextLayout,
  864.                                  ATSUTextMeasurement     iTextBasePointX,
  865.                                  ATSUTextMeasurement     iTextBasePointY,
  866.                                  UniCharArrayOffset     iHighlightStart,
  867.                                  UniCharCount             iHighlightLength,
  868.                                  RgnHandle                 oHighlightRegion);
  869.  
  870. /*    Hit-testing    */
  871. EXTERN_API_C( OSStatus )
  872. ATSUPositionToOffset            (ATSUTextLayout         iTextLayout,
  873.                                  ATSUTextMeasurement     iLocationX,
  874.                                  ATSUTextMeasurement     iLocationY,
  875.                                  UniCharArrayOffset *    ioPrimaryOffset,
  876.                                  Boolean *                oIsLeading,
  877.                                  UniCharArrayOffset *    oSecondaryOffset);
  878.  
  879. EXTERN_API_C( OSStatus )
  880. ATSUOffsetToPosition            (ATSUTextLayout         iTextLayout,
  881.                                  UniCharArrayOffset     iOffset,
  882.                                  Boolean                 iIsLeading,
  883.                                  ATSUCaret *            oMainCaret,
  884.                                  ATSUCaret *            oSecondCaret,
  885.                                  Boolean *                oCaretIsSplit);
  886.  
  887. /*    Cursor movement    */
  888. EXTERN_API_C( OSStatus )
  889. ATSUNextCursorPosition            (ATSUTextLayout         iTextLayout,
  890.                                  UniCharArrayOffset     iOldOffset,
  891.                                  ATSUCursorMovementType  iMovementType,
  892.                                  UniCharArrayOffset *    oNewOffset);
  893.  
  894. EXTERN_API_C( OSStatus )
  895. ATSUPreviousCursorPosition        (ATSUTextLayout         iTextLayout,
  896.                                  UniCharArrayOffset     iOldOffset,
  897.                                  ATSUCursorMovementType  iMovementType,
  898.                                  UniCharArrayOffset *    oNewOffset);
  899.  
  900. EXTERN_API_C( OSStatus )
  901. ATSURightwardCursorPosition        (ATSUTextLayout         iTextLayout,
  902.                                  UniCharArrayOffset     iOldOffset,
  903.                                  ATSUCursorMovementType  iMovementType,
  904.                                  UniCharArrayOffset *    oNewOffset);
  905.  
  906. EXTERN_API_C( OSStatus )
  907. ATSULeftwardCursorPosition        (ATSUTextLayout         iTextLayout,
  908.                                  UniCharArrayOffset     iOldOffset,
  909.                                  ATSUCursorMovementType  iMovementType,
  910.                                  UniCharArrayOffset *    oNewOffset);
  911.  
  912. /*    Line breaking    */
  913. EXTERN_API_C( OSStatus )
  914. ATSUBreakLine                    (ATSUTextLayout         iTextLayout,
  915.                                  UniCharArrayOffset     iLineStart,
  916.                                  ATSUTextMeasurement     iLineWidth,
  917.                                  Boolean                 iUseAsSoftLineBreak,
  918.                                  UniCharArrayOffset *    oLineBreak);
  919.  
  920. EXTERN_API_C( OSStatus )
  921. ATSUSetSoftLineBreak            (ATSUTextLayout         iTextLayout,
  922.                                  UniCharArrayOffset     iLineBreak);
  923.  
  924. EXTERN_API_C( OSStatus )
  925. ATSUGetSoftLineBreaks            (ATSUTextLayout         iTextLayout,
  926.                                  UniCharArrayOffset     iRangeStart,
  927.                                  UniCharCount             iRangeLength,
  928.                                  ItemCount                 iMaximumBreaks,
  929.                                  UniCharArrayOffset     oBreaks[],
  930.                                  ItemCount *            oBreakCount);
  931.  
  932. EXTERN_API_C( OSStatus )
  933. ATSUClearSoftLineBreaks            (ATSUTextLayout         iTextLayout,
  934.                                  UniCharArrayOffset     iRangeStart,
  935.                                  UniCharCount             iRangeLength);
  936.  
  937. /*    Font matching    */
  938. EXTERN_API_C( OSStatus )
  939. ATSUSetFontFallbacks            (ItemCount                 iFontFallbacksCount,
  940.                                  ATSUFontID             iFontIDs[],
  941.                                  ATSUFontFallbackMethod  iFontFallbackMethod);
  942.  
  943. EXTERN_API_C( OSStatus )
  944. ATSUGetFontFallbacks            (ItemCount                 iMaxFontFallbacksCount,
  945.                                  ATSUFontID             oFontIDs[],
  946.                                  ATSUFontFallbackMethod * oFontFallbackMethod,
  947.                                  ItemCount *            oActualFallbacksCount);
  948.  
  949. EXTERN_API_C( OSStatus )
  950. ATSUMatchFontsToText            (ATSUTextLayout         iTextLayout,
  951.                                  UniCharArrayOffset     iTextStart,
  952.                                  UniCharCount             iTextLength,
  953.                                  ATSUFontID *            oFontID,
  954.                                  UniCharArrayOffset *    oChangedOffset,
  955.                                  UniCharCount *            oChangedLength);
  956.  
  957. EXTERN_API_C( OSStatus )
  958. ATSUSetTransientFontMatching    (ATSUTextLayout         iTextLayout,
  959.                                  Boolean                 iTransientFontMatching);
  960.  
  961. EXTERN_API_C( OSStatus )
  962. ATSUGetTransientFontMatching    (ATSUTextLayout         iTextLayout,
  963.                                  Boolean *                oTransientFontMatching);
  964.  
  965. /*    Font ID's    */
  966. EXTERN_API_C( OSStatus )
  967. ATSUFontCount                    (ItemCount *            oFontCount);
  968.  
  969. EXTERN_API_C( OSStatus )
  970. ATSUGetFontIDs                    (ATSUFontID             oFontIDs[],
  971.                                  ItemCount                 iArraySize,
  972.                                  ItemCount *            oFontCount);
  973.  
  974. EXTERN_API_C( OSStatus )
  975. ATSUFONDtoFontID                (short                     iFONDNumber,
  976.                                  Style                     iFONDStyle,
  977.                                  ATSUFontID *            oFontID);
  978.  
  979. EXTERN_API_C( OSStatus )
  980. ATSUFontIDtoFOND                (ATSUFontID             iFontID,
  981.                                  short *                oFONDNumber,
  982.                                  Style *                oFONDStyle);
  983.  
  984. /*    Font names    */
  985. EXTERN_API_C( OSStatus )
  986. ATSUCountFontNames                (ATSUFontID             iFontID,
  987.                                  ItemCount *            oFontNameCount);
  988.  
  989. EXTERN_API_C( OSStatus )
  990. ATSUGetIndFontName                (ATSUFontID             iFontID,
  991.                                  ItemCount                 iFontNameIndex,
  992.                                  ByteCount                 iMaximumNameLength,
  993.                                  Ptr                     oName,
  994.                                  ByteCount *            oActualNameLength,
  995.                                  FontNameCode *            oFontNameCode,
  996.                                  FontPlatformCode *        oFontNamePlatform,
  997.                                  FontScriptCode *        oFontNameScript,
  998.                                  FontLanguageCode *        oFontNameLanguage);
  999.  
  1000. EXTERN_API_C( OSStatus )
  1001. ATSUFindFontName                (ATSUFontID             iFontID,
  1002.                                  FontNameCode             iFontNameCode,
  1003.                                  FontPlatformCode         iFontNamePlatform,
  1004.                                  FontScriptCode         iFontNameScript,
  1005.                                  FontLanguageCode         iFontNameLanguage,
  1006.                                  ByteCount                 iMaximumNameLength,
  1007.                                  Ptr                     oName,
  1008.                                  ByteCount *            oActualNameLength,
  1009.                                  ItemCount *            oFontNameIndex);
  1010.  
  1011. EXTERN_API_C( OSStatus )
  1012. ATSUFindFontFromName            (Ptr                     iName,
  1013.                                  ByteCount                 iNameLength,
  1014.                                  FontNameCode             iFontNameCode,
  1015.                                  FontPlatformCode         iFontNamePlatform,
  1016.                                  FontScriptCode         iFontNameScript,
  1017.                                  FontLanguageCode         iFontNameLanguage,
  1018.                                  ATSUFontID *            oFontID);
  1019.  
  1020. /*    Font features    */
  1021. EXTERN_API_C( OSStatus )
  1022. ATSUCountFontFeatureTypes        (ATSUFontID             iFontID,
  1023.                                  ItemCount *            oTypeCount);
  1024.  
  1025. EXTERN_API_C( OSStatus )
  1026. ATSUCountFontFeatureSelectors    (ATSUFontID             iFontID,
  1027.                                  ATSUFontFeatureType     iType,
  1028.                                  ItemCount *            oSelectorCount);
  1029.  
  1030. EXTERN_API_C( OSStatus )
  1031. ATSUGetFontFeatureTypes            (ATSUFontID             iFontID,
  1032.                                  ItemCount                 iMaximumTypes,
  1033.                                  ATSUFontFeatureType     oTypes[],
  1034.                                  ItemCount *            oActualTypeCount);
  1035.  
  1036. EXTERN_API_C( OSStatus )
  1037. ATSUGetFontFeatureSelectors        (ATSUFontID             iFontID,
  1038.                                  ATSUFontFeatureType     iType,
  1039.                                  ItemCount                 iMaximumSelectors,
  1040.                                  ATSUFontFeatureSelector  oSelectors[],
  1041.                                  Boolean                 oSelectorIsOnByDefault[],
  1042.                                  ItemCount *            oActualSelectorCount,
  1043.                                  Boolean *                oIsMutuallyExclusive);
  1044.  
  1045. EXTERN_API_C( OSStatus )
  1046. ATSUGetFontFeatureNameCode        (ATSUFontID             iFontID,
  1047.                                  ATSUFontFeatureType     iType,
  1048.                                  ATSUFontFeatureSelector  iSelector,
  1049.                                  FontNameCode *            oNameCode);
  1050.  
  1051. /*    Font tracking value & names    */
  1052. EXTERN_API_C( OSStatus )
  1053. ATSUCountFontTracking            (ATSUFontID             iFontID,
  1054.                                  ATSUVerticalCharacterType  iCharacterOrientation,
  1055.                                  ItemCount *            oTrackingCount);
  1056.  
  1057. EXTERN_API_C( OSStatus )
  1058. ATSUGetIndFontTracking            (ATSUFontID             iFontID,
  1059.                                  ATSUVerticalCharacterType  iCharacterOrientation,
  1060.                                  ItemCount                 iTrackIndex,
  1061.                                  Fixed *                oFontTrackingValue,
  1062.                                  FontNameCode *            oNameCode);
  1063.  
  1064. /*    Font variations    */
  1065. EXTERN_API_C( OSStatus )
  1066. ATSUCountFontVariations            (ATSUFontID             iFontID,
  1067.                                  ItemCount *            oVariationCount);
  1068.  
  1069. EXTERN_API_C( OSStatus )
  1070. ATSUGetIndFontVariation            (ATSUFontID             iFontID,
  1071.                                  ItemCount                 iVariationIndex,
  1072.                                  ATSUFontVariationAxis * oATSUFontVariationAxis,
  1073.                                  ATSUFontVariationValue * oMinimumValue,
  1074.                                  ATSUFontVariationValue * oMaximumValue,
  1075.                                  ATSUFontVariationValue * oDefaultValue);
  1076.  
  1077. EXTERN_API_C( OSStatus )
  1078. ATSUGetFontVariationNameCode    (ATSUFontID             iFontID,
  1079.                                  ATSUFontVariationAxis     iAxis,
  1080.                                  FontNameCode *            oNameCode);
  1081.  
  1082. /*    Font Instances    */
  1083. EXTERN_API_C( OSStatus )
  1084. ATSUCountFontInstances            (ATSUFontID             iFontID,
  1085.                                  ItemCount *            oInstances);
  1086.  
  1087. EXTERN_API_C( OSStatus )
  1088. ATSUGetFontInstance                (ATSUFontID             iFontID,
  1089.                                  ItemCount                 iFontInstanceIndex,
  1090.                                  ItemCount                 iMaximumVariations,
  1091.                                  ATSUFontVariationAxis     oAxes[],
  1092.                                  ATSUFontVariationValue  oValues[],
  1093.                                  ItemCount *            oActualVariationCount);
  1094.  
  1095. EXTERN_API_C( OSStatus )
  1096. ATSUGetFontInstanceNameCode        (ATSUFontID             iFontID,
  1097.                                  ItemCount                 iInstanceIndex,
  1098.                                  FontNameCode *            oNameCode);
  1099.  
  1100.  
  1101. #if PRAGMA_STRUCT_ALIGN
  1102.     #pragma options align=reset
  1103. #elif PRAGMA_STRUCT_PACKPUSH
  1104.     #pragma pack(pop)
  1105. #elif PRAGMA_STRUCT_PACK
  1106.     #pragma pack()
  1107. #endif
  1108.  
  1109. #ifdef PRAGMA_IMPORT_OFF
  1110. #pragma import off
  1111. #elif PRAGMA_IMPORT
  1112. #pragma import reset
  1113. #endif
  1114.  
  1115. #ifdef __cplusplus
  1116. }
  1117. #endif
  1118.  
  1119. #endif /* __ATSUNICODE__ */
  1120.  
  1121.